home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / sillies / _kangakoe / _xhelp / _helptext < prev    next >
Text File  |  1992-02-27  |  23KB  |  1,007 lines
  1. {!title        -- The XHelp index.. -- } 
  2.                     !XHelp 
  3.  
  4. {!index Introduction}
  5. A Cross Reference Text Display Utility.
  6. {!index Overview}Overview.  
  7.  
  8. This programme will display an ascii
  9. textfile, just like !Edit. However some
  10. words/sentences are crossreferenced. These
  11. '{⇨annotated}' words show up with a grey back-
  12. ground. DClicking on these words will bring 
  13. you to a place in the text which is associa-
  14. ted with this word, a '{⇨reference}'.
  15.  
  16. Apart from that there is also an {⇨index}, from
  17. were the 'idexed chapters' can be reached
  18. quickly.
  19.  
  20. To help you keep track of were you were,
  21. i.e. where you left the 'main text' to read a
  22. {⇨reference}, one further aid has been build
  23. into the programme: {⇨Bookmarkers}.
  24.  
  25. The work just as regular bookmarkers. You
  26. can {⇨insert them at a certain point} and {⇨flip}
  27. to them quickly at another time. You can
  28. insert them manualy, however when you leave
  29. the text at a certain point to jump to
  30. either the {⇨index} or a {⇨referenced word}, a
  31. {⇨bookmarker} is left automaticly. This
  32. enables you to return to your text after
  33. having read a reference. The bookmarkers are
  34. accesible in a {⇨LastIn-FirstOut} stacked
  35. order, unlike their real-live counterparts.
  36.  
  37. The programme supports {⇨interactive help}.
  38.  
  39. {!index Getting started}
  40. Getting started.
  41.  
  42. You are now reading the !Help file of the
  43. application !XHelp. When you DClick on the
  44. !Xhelp application in the filer window a
  45. demo file will be shown.
  46.  
  47. You can do that NOW, whilst leaving this
  48. text on the screen. Also start Acorns !Help
  49. application, you can find it on application
  50. disc one.
  51.  
  52. Right. A window, titled Helper, should have
  53. appeard in the middle of the screen. A
  54. {⇨toolbox} has appeared to the left. It
  55. contains four icons.
  56.  
  57. The top two icons are for the bookmarker 
  58. handling, the bottom two allow you to switch
  59. betwee text and index. Curently the text
  60. should be displayed.
  61.  
  62. Now click on the bottom icon in the toolbox,
  63. the index icon. (You can verify this by
  64. looking in the {⇨'Interactive Help' window.})
  65.  
  66. The contents of the window should change
  67. now, a header saying 'The INDEX, compiled'
  68. appears, followed by four items preceeded by
  69. a grey box, numbered 1..4.
  70.  
  71. You can DClick on each of these items. Let's
  72. try the second item, introduction.
  73.  
  74. DClick on the grey area. The window will
  75. change and the introductotory text will
  76. apear. 
  77.  
  78. Right. Read It ?
  79.  
  80. Now suppose that you want to return to the
  81. place you left just before you read the
  82. index. Clicking on the second bookmarker
  83. icon in the toolbox will get you there.
  84. Again, studying the 'Interactive help'
  85. explanations should get you going.
  86.  
  87. Once you have returned there, you will see
  88. that several 'difficult' words have been
  89. referenced, i.e. 'they have a grey
  90. background'. These words are annotated...
  91.  
  92. DClicking on these words will bring you to a
  93. short reference. Once you have read the
  94. reference you can return to the place you've
  95. left to read that reference by using the
  96. 'return to bookmarker' icon, the second icon
  97. from the top. 
  98.  
  99. Right thats all there is to this application
  100. apart from the thing that you can leave a
  101. bookmarker by clicking on it. A black
  102. triangle will show, defining the exact spot
  103. to were you will return when you click the
  104. 'return to bookmark' icon.
  105. {<LastIn-FirstOut}
  106. The bookmarks are stored on a LiFo basis, a
  107. computer boffins term for a certain stacking
  108. method. It works on a LastIn, FirstOut
  109. basis, or if you prefer FirtsIn, LastOut.
  110. This means that Clicking on the 'return to
  111. bookmark' icon will bring you both to the
  112. topmost marker, ie the last marker inserted
  113. AND will remove that marker.
  114.  
  115. Apart from these there are a few more actions,
  116. these are mainle preformed with the ADJUST 
  117. button, refer to the appedix for this.
  118.  
  119. Now we will deal with the main features..
  120.  
  121. {!index The Manual}
  122.  
  123. From the users point of view...
  124.  
  125.  There are three important concepts in this
  126.  programme:
  127.  
  128.  o The annotation/reference structure
  129.  o The bookmarers and 
  130.  o The index
  131.  
  132.  We will deal with these three in dept, 
  133.  DClick on these items to get the information
  134.  concerned.
  135.  
  136. From the 'writers' point of view.
  137.  
  138.  Together with the users-list of concepts, the
  139.  following list will give a complete overview.
  140.  o main text
  141.  o token structure
  142.  o coding -annotations
  143.           -references
  144.           -index items
  145.                  title
  146.           -colours
  147.  o configuring
  148.  o limits -speed
  149.           -memory
  150.  
  151.  Apart from these, there is also a reference
  152.  section, which is most easly accesed through
  153.  the index system.
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168. ----------------------------------------------
  169. -------    U S E R S   G U I D E      --------
  170. ----------------------------------------------
  171.  
  172. {!index USERs Guide}
  173. {!index      - Annotation/references structure}
  174. {<annotated}{<reference}{<referenced word}
  175. Annotation/Reference structure
  176.  
  177.  Normaly a reference is a bit of text, often
  178.  numbered, to which the numbered annotation 
  179.  points. 
  180.  
  181.  An example could be this fragment,
  182.  
  183.    "... however most Acorn¹ Computers were
  184.     assembled in the early 1960's on a ..."
  185.  
  186.  Matching the '¹' annotation at the bottom of
  187.  the page you would find something like..
  188.  
  189. {<'Acorn'}  ¹) Acorn, a small Camebridebased compagny
  190.      building unconventional but very special
  191.      homecomputers, among which the elevated
  192.      BBC Micro Computer.
  193.     
  194.  The '¹' is called the annotation, Acorn is the
  195.  annotated word. The explanation preceeded by the
  196.  ¹) is the reference.
  197.  
  198.  In this computer versioun one would expect the
  199.  word {⇨'Acorn'} to have a grey background. 
  200.  DClicking on it would lead to the ¹) reference.
  201.  
  202.  Just try....
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221. ==============================================
  222. {!index      - On Bookmarkers} {<Bookmarkers}{<bookmarker}
  223.  
  224. On bookmarkers...
  225.  
  226. To help you keep track of were you were,
  227. for example where you left the {⇨main text} 
  228. to read a {⇨reference}, one further aid has
  229. been build into the programme: 
  230.  
  231.          Bookmarkers.
  232.  
  233. The work just as regular bookmarkers. You
  234. can {⇨insert them at a certain point} and {⇨flip}
  235. to them quickly at another time. You can
  236. insert them manualy, however when you leave
  237. the text at a certain point to jump to
  238. either the {⇨index} or a {⇨referenced word}, a
  239. {⇨bookmarker} is left automaticly. This
  240. enables you to return to your text after
  241. having read a reference. The bookmarkers are
  242. accesible in a {⇨LastIn-FirstOut} stacked
  243. order, unlike their real-live counterparts.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269. ==============================================
  270. {!index      - On indexes}{<index} 
  271.  
  272. On the index 
  273.  
  274.  Every {⇨display-file} can have an index. The
  275.  index can displayed by clicking on the
  276.  index icon. It is not compulsory
  277.  to have an index. If there is no index
  278.  defined then a text telling you so will be
  279.  displayed...
  280.  
  281.  The index falls into three parts, the
  282.  title, the items, and the grey numbered
  283.  reference boxes.
  284.  
  285.  Each item is preceeded by a grey numbered
  286.  box. These serve as 'clicking pads'. DClicing
  287.  on them will bring you to that item. You
  288.  can always leave the index by clicking on
  289.  the 'main text' icon. You will be brought
  290.  to the place you left when you clicked 
  291.  the 'index icon' in the first place.
  292.  
  293.  I leave it to the interested reader to
  294.  discover the obvious title.
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304. {!index Writers Guide...}
  305.  
  306. ----------------------------------------------
  307. -------  W R I T E R S   G U I D E    --------
  308. ----------------------------------------------
  309.  
  310. {<main text}
  311. {!index    - Main text}Main text
  312.  
  313.   The main thing the writer has to do is to
  314.   write the 'main text', i.e. the text which
  315.   is going to be displayed in this window.
  316.  
  317.   The main text is actually the only data-
  318.   structure. It can be edited with any ascii
  319.   editor, like !Edit, and you do not need
  320.   a fancy programme to specify the index or
  321.   the references.
  322.  
  323.   This maintext is in stored as a file, the
  324.              {⇦'display-file'}{<'display file'}
  325.  
  326.   All the special features are coded into
  327.   the ascii text. But first, the character-
  328.   istics of the main text...
  329.  
  330.   
  331. {!index        o filename}Filename 
  332.    
  333.    Both filename and file path are completely
  334.    free. No assumptions are made. The file
  335.    displayed is in the OSvar:
  336.  
  337.    <Xhelp$Xtext>
  338.  
  339.    And you can set it to any path by commands
  340.    like:
  341.  
  342.    Set Xhelp$Xtext <obey$dir>.ReadMe 
  343.    Set Xhelp$Xtext IDEFS::Harddisc4.$.Examp
  344.    
  345.    These paths do not depent on the appli-
  346.    cation dir of !Xhelp. The var Xhelp$Xtext
  347.    is currently defined in the !Run file of
  348.    Xhelp, feel free to change things.
  349.  
  350.  
  351.  
  352. {!index        o filetype} Filetype 
  353.  
  354.   Although no checking is done, use a &FFF or
  355.   text type for the time being. Expect the
  356.   programme to be adapted in the near future
  357.   to autorun certain filetypes. 
  358.  
  359. {!index        o tokenstructure} Token structure
  360.  
  361.   Commands always have this format :
  362.  
  363.   '{/}token parameters{\}
  364.  
  365.    A space between token and paramter is 
  366.    compulsory. Currently the following
  367.    tokens are defined :
  368.  
  369.     < annotation           , one param
  370.     ⇨ reference            , one param
  371.     ! subcommand:           
  372.        title               , one param
  373.        index               , one param
  374.        col                 , 16 params
  375.     / trick to obtain a {/}  , no params
  376.     \ trick to obtain a {\}  , no params
  377.  
  378. the '{/}' trick
  379.  
  380.     As you cannot use the chars {\} and {/}
  381.     freely a little trick allows you to
  382.     code them:
  383.  
  384.     In asccifile       Displayed
  385.     {/}/{\}                {/}
  386.     {/}\{\}                {\}
  387.   
  388. {!index      o Auto run}Auto run
  389.  
  390.     No filetype has been chosen yet, so this
  391.     function is switched off.
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414. ==============================================
  415.  
  416. {!index    - The index} 
  417. The index
  418.  Every {⇨display-file} can have an index. The
  419.  index can displayed by clicking on the
  420.  index icon. It is not compulsory
  421.  to have an index. A suiteble text, see
  422.  message {⇨US2}, will be displayed if no
  423.  index is available.
  424.  
  425.  The index falls into three parts, the
  426.  title, the items, and the grey numbered
  427.  reference boxes.
  428.             
  429. {!index        o title}* The title. 
  430.  
  431.  The index can have title defined in your 
  432.  text. If you do not define a title in
  433.  your display-file, a preset title will
  434.  be used, see message {⇨US1}.
  435.  
  436.  The definition of the title has the form
  437.  
  438.  {/}!title just as title{\}  
  439.  
  440.  The 'title' token is case-sensitive, and
  441.  the space just after !title is ignored.
  442.  
  443.  The whole {/}..{\} definition MUST be on the 
  444.  first line of your file. the {/}..{\} must be
  445.  the first character.
  446.  
  447.  Hint {/}!index {\} will result in no title
  448.  at all.
  449.  
  450. {!index        o items}* The items
  451.  
  452.   Items are the beast which make up the
  453.   index. There can be as many as you 
  454.   like. However there is a small catch,
  455.   as the index is compiled on each (re)
  456.   draw of the index, long indexes on long
  457.   files do take their time.
  458.  
  459.   An index token is placed somewere in
  460.   the text, in the line it refers to. It
  461.   has the structure :
  462.  
  463.   {/}!index Introduction{\}
  464.  
  465.   Again the word 'index' is case-sensitive,
  466.   and the space is ignored. It can be placed
  467.   anywere in the text. It is not displayed.
  468.  
  469. {!index        o grey boxes}* The grey reference boxes
  470.  
  471.   Each item is prefixed by a grey box with
  472.   a black number in it. Double clicking with
  473.   select in these boxes will result in a
  474.   jump to that index point, the place
  475.   where the matching '!index ..' reference
  476.   is found.
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491. ==============================================
  492. {!index    - Bookmarkers}Bookmarkers
  493.  
  494.  A bookmarker serves as a temporarily
  495.  reminder of a place in the text.
  496.  
  497.  Up to 64 bookmarkers can be defined in
  498.  a stackwise fashion. 
  499.  
  500.  Either the programme will place bookmarks
  501.  or the user.
  502.  
  503.  The programme places bookmarKs if you
  504.  switch to the index, and will jump and
  505.  remove that bookmarker if you return
  506.  to the main text.
  507.  
  508.  It will also place a bookmark if you jump
  509.  to a reference or index-rerenced spot.
  510.  
  511.  In addition you can also place the book-
  512.  markers with the '{⇨leave bookmark}' icon
  513.  in the toolbox.
  514.  
  515.  You can only access the topmost marker, also
  516.  referred to as the latest or newest book-
  517.  marker. This is done by the '{⇨goto bookmark}'
  518.  function.
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535. ==============================================
  536. {!index    - Annotations}Annotations
  537.  
  538.  Any word can have an annotation.
  539.  
  540.  This annotation 'points' to a certain reference.
  541.  An annotated word(s) looks like
  542.  
  543.  {⇨An Annotation}
  544.  
  545.  and is ASCII coded like
  546.  
  547.  {/}⇨An Annotation{\}
  548.  
  549.  DClicking on these annotation will bring you to
  550.  the first associated reference. On DClick
  551.  a search is made, starting on the first line
  552.  of the main text, for a reference with EXACTLY
  553.  the same word(s) as in the annotation. DClick
  554.  on {⇨An Annotation} to see the reference.
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578. ==============================================
  579. {!index    - References}References 
  580.  
  581.  Normaly a reference is a bit of text, often
  582.  numbered, to which the numbered annotation 
  583.  points. 
  584.  
  585.  An example could be about The Acorn¹ Computer
  586.  build in the early 1960 at Culham. At the
  587.  bottom of the page you would find something
  588.  like..
  589.  
  590.  ¹) Acorn, a small Camebridebased compagny
  591.     building unconventional but very special
  592.     homecomputers, among which the elevated
  593.     BBC Micro Computer.
  594.     
  595.  The XHelp programme uses references in a slightly
  596.  stricter sense. A reference is a place in the 
  597.  text to which any annotation might point.
  598.  
  599.  A reference can be hidden or visible. 
  600.  
  601.  The structure is..
  602.  
  603.  Hidden  :  {/}<string{\}
  604.  Visible :  {/}<string{\} looks like {⇦string}
  605.  
  606.  The string must be spelled exactly as the 
  607.  matching annotation. Below you can see the
  608.  matching reference to {⇨An Annotation}
  609.  
  610.  {⇦An Annotation} coded as {/}⇦An Annotation{\}
  611.  
  612.  On DClick on '{⇨An Annotation}' to page to
  613.  this reference.
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627. ============================================== 
  628. {!index -   Techo stuff...}
  629. {!index      o Memory consumption}Programme memory consumtion
  630.  
  631.  Before the text file is loaded the required
  632.  memory is claimed from the free wimp-pool.
  633.  
  634.  This will assure minimal memory consumption,
  635.  althoug people with little memory will be
  636.  better of, on a four meg machine, the small-
  637.  est chunck is 32k.
  638.  
  639.  As the index is compiled during the display
  640.  of that index no memory is used up for a
  641.  index building.
  642.  
  643.  The same goes for references and annotations
  644.  which are checked/found on the spot, no 
  645.  elaborate tables are set up and stored.
  646.  
  647.  However a small table is build while loading
  648.  the text file, storing the addresses where
  649.  each sucsessive line starts in memory. This
  650.  enables the programme to redraw the screen
  651.  quicly. The length of this table is calculated
  652.  from the file lenght. This is a guessed process
  653.  and a verY short avarage line-lenght can upset
  654.  the guessing algorithm. the error 'Too many 
  655.  lines.., message {⇨ER5} will be given. Very
  656.  long lines however will result in a memory 
  657.  waste of up to 4 percent on long files.
  658.  
  659.  
  660. {!index      o Speed}Speed 
  661.  
  662.  No speed optimalization has been done yet.
  663.  
  664.  I am planning to hand-code things into
  665.  arm-assembler. Hold on for now.
  666.  
  667.  You will find that speed does matter,
  668.  especially during index display. To
  669.  save memory all interpreting actions
  670.  are done on the spot.
  671.  
  672. Colours customizing
  673. {!index      o Colours customizing}
  674.  
  675.  Has been build in, but not tested yet, hang
  676.  on for this.
  677.  
  678.  Anyway, the first line should read..
  679.  
  680.  {/}!col xxxxxxxxxx{\}
  681.  
  682.  With xxxxxxxxx numbers from 0..F or an X.
  683.  
  684.  Parameter 1 text background, not used.
  685.            2      foreground.
  686.            3 reference  bg
  687.            4            gg
  688.            5 Annotation bg
  689.            6            fg
  690.            7 Index      bg
  691.            8            fg
  692.            9 Marker     last
  693.           10            others
  694.  
  695.  An X indicates that the defaults have to be
  696.  used. Example, if the first line looks like
  697.  
  698.  {/}!title the demo index{\}{/}!col xxxxC6xxxx{\}
  699.  
  700.  you can be sure that the colours of the 
  701.  annotated words are dark-grey on a slightly
  702.  off white, yellowish, colour.
  703.  
  704.  
  705. {!index Reference Section}
  706.  
  707. {!index - Features}
  708. Features
  709.  o {⇨Asciifile} display in scrollable window
  710.  o Length only limited by {⇨memory}
  711.  o Full {⇨reference} posibilities
  712.  o Easy {⇨bookmarker} actions
  713.  o Offers easy access for the beginner, but
  714.    remains quick enough to the expert
  715.  o {⇨Online index compilation}
  716.  o Easy writing of {⇨sourcetext}, just with !Edit
  717.  o Small apllication <32Kram
  718.  o {⇨Installs} in any directory, especially on
  719.    a hardisc.
  720.  o interactive help
  721.  o adaptable programe dialogues/messages
  722.  o Can be auto-run on certain filetypes
  723.  o {⇨Multi langual}
  724.  
  725. {<interactive help}.
  726. {!index - Interactive Help}Interactive Help
  727.  
  728.  This programme supports level-1 interactive
  729.  help as asked for by the Acorn !Help appli-
  730.  cation on the welcome disk (version 1.13).
  731.  
  732.  You can load this !Help programme. 
  733. {<'Interactive Help' window.}
  734.  It will open a window titled 'interactive help' 
  735.  which will display any information avalable
  736.  about the object the pointer is curently
  737.  pointing at.
  738.  
  739.  This !Xhelp application will make a lot
  740.  of information available. All it functions
  741.  are covered. 
  742.  
  743.  Expert can change the information displayed.
  744.  The information messages are coded {⇨H01..H11}
  745.  in the message file.
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754. {<toolbox}
  755. {!index - The toolbox}Toolbox
  756.  
  757.  The toolbox is situated left of the main
  758.  window. It has no title bar and it is
  759.  attached firmly to the main window. It
  760.  has 4 icons on a grey background. Each
  761.  icon has a few special functions. The
  762.  easiest way to obtain information is to
  763.  use the interactive help application.
  764.  
  765.  The four icons function are 'Leave book-
  766.  marker','goto bookmarker','show maintext', 
  767.  and 'show index'. The respond to SELECT 
  768.  and ADJUST in a different way. Use SELECT
  769.  only if you are new to the programme.
  770. {<insert them at a certain point}{<leave bookmark}
  771. {!index   o Leave bookmarker}*'Leave bookmarker'
  772.  
  773.  The icon is intended to look like a book-
  774.  marker pointing right to the text. It is
  775.  the first icon from the top in the toolbox.
  776.  
  777.  Clicking SELECT will leave a bookmarker to
  778.  which you can return with the function 
  779.  'goto bookmarker'. A black triangle will
  780.  mark the spot.
  781.  
  782.  ADJUST will bring you to the last marker
  783.  and is functionally the same as 'goto
  784.  bookmarker.
  785.  
  786.  The bookmarkers are stored stackwise. Only
  787.  the newest marker is accesible. Up to 64
  788.  markers can be placed.
  789. {<flip}{<goto bookmark}
  790. {!index   o Goto bookmarker}*'Goto bookmarker'
  791.  
  792.  This is the second icon from the top, it
  793.  also looks bookmarker, vertical, pointing
  794.  downwards with two black triangles in it,
  795.  both pointing back, left.
  796.  
  797.  Clicking on it with SELECT will bring
  798.  you to the newest bookmarker. This book-
  799.  marker will be removed when you arrive
  800.  to its spot. If there are no bookmarkers
  801.  a beep will be heard.
  802.  
  803.  However using ADJUST will not remove the
  804.  latest bookmarker, you can use it to return
  805.  time after time to the same spot.
  806.  
  807. {!index   o Display main text}*'Display main text'
  808.  
  809.  This is the third icon from the top in the
  810.  toolbox. It looks like a 'text'
  811.  
  812.  Clicking SELECT will force the main window
  813.  to display the main text. If the main
  814.  text is already there a beeb will be heard.
  815.  
  816.  Clicking ADJUST will toggle the contents of
  817.  the main window. It will switch to the Index
  818.  if the main text was on display or the other
  819.  way round.
  820.  
  821.  The programme will 'bookmark' the main text
  822.  before displaying the index, so on return
  823.  you are brought back to the exact spot you
  824.  had left.
  825.  
  826. {!index   o Display index}*'Display Index'
  827.  
  828.  This is the bottom icon in the toolbox. It
  829.  should look like an 'numbered index'
  830.  
  831.  Clicking SELECT will force the main window
  832.  to display the index. If the index is 
  833.  already there a beeb will be heard.
  834.  
  835.  Clicking ADJUST will toggle the contents of
  836.  the main window. It will switch to the Index
  837.  if the main text was on display or the other
  838.  way round. 
  839.  
  840.  The programme will 'bookmark' the main text
  841.  before displaying the index, so on return
  842.  you are brought back to the exact spot you
  843.  had left.
  844.  
  845.  
  846.  
  847. {!index - Internationalizing}
  848. Internationalizing
  849.  
  850. The Message file in the application directory
  851. can be changed. The lines contain a 3 char
  852. code, a double colon and a string terminated
  853. by either a chr(13) or a chr(10).
  854.  
  855. This string can be freely translated/changed. 
  856. However you are oblidged (to rename and) leave
  857. the original message file in the directory if
  858. you pass it along. The USx messages are the
  859. ones a user most likely would like to change.
  860.  
  861. A short abstract is given below :
  862.  
  863. ERx: codes, errors after which the
  864.      application will quit...
  865.  
  866. {<ER1}     ER1:Cannot find the file to be shown
  867. {<ER7}     ER7:Cannot find my sprite file 
  868. {<ER2}     ER2:Cannot find my template file.
  869. {<ER3}     ER3:Unexpected redraw request
  870. {<ER5}     ER5:Too many lines..
  871. {<ER6}     ER6:Missing { or } at line :
  872. {<ER8}     ER8:index_reference not found
  873. {<ER9}     ER9:Cannot retrun to bookmarker 
  874. {<ER4}     ER4:File has lenght ZERO !
  875.  
  876. Two messages for general use..
  877.  
  878. {<WAR}     WAR:Please note... :   
  879. {<AP1}     AP1:Displaying 'Xref'ed files 
  880.  
  881. The main user configurable messages
  882.  
  883. {<US1}     US1:Default index header
  884. {<US2}     US2:Default 'no index' text
  885. {<US3}     US3:Default warning if a annotaion/
  886.          reference set is not found!
  887.  
  888. And finally H01 .. H11:{⇦H01..H11}
  889.      are the interactive help messages.
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907. {!index - The window and mouse actions}
  908. The Window and mouse actions
  909.  
  910.  The main window responds to the following
  911.  actions.
  912.  
  913.  DClick with select on a annotated word/index
  914.  item.
  915.  
  916.    Which will jump to the reference/indexed
  917.    place in the main text.
  918.  
  919.  DClick with adjust on plain text.
  920.  
  921.    Which doubles the return to last marker
  922.    action.
  923.  
  924.  Pressing Menu.
  925.  
  926.    This will bring up a menu with the
  927.    items info and quit along with a plain
  928.    print options.
  929.  
  930.  
  931.  
  932.  
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.  
  944.  
  945. {!index - The application}
  946. The application
  947.  
  948.  The application consists of 10 files, which
  949.  are stored in the !XHelp dir.
  950.  
  951.  Acorn specific names/functions :
  952.  
  953.   !Run           type OBEY     ;to start-up
  954.   !Help               OBEY     ;provide help
  955.   !Sprites            SPRITE   ;filer-picture
  956.  
  957.  The running kernel :
  958.  
  959.   !RunImage           BASIC    ;the worker
  960.  
  961.  This helpfile :
  962.  
  963.   !HelpText           TEXT     ;this text
  964.  
  965.  And some defintions files :
  966.   Messages            TEXT     ;user editable 
  967.                                 messages,
  968.   Sprites             SPRITE   ;toolbox icons
  969.   Templates           TEMPLATE ;window defs
  970.   menus               DATA     ;menu defs
  971.  
  972.  And finally there is the textfile to
  973.  be displayed, often named 
  974.  
  975.  Textfile             TEXT
  976.  
  977.  It uses two system vars..
  978.  
  979.  Xhelp$Dir   ; full path to the appl. dir
  980.  Xhelp$Xtext ; the text to be displayed
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993. {!index - Printing}
  994. Printing
  995.  
  996.  Printing is possible. Use menu on the main
  997.  window and use the middle item. The text
  998.  file is brutally copied to the Printer:
  999.  path, including coded references etc.
  1000.  
  1001.  There are no subtilities in this, the whole
  1002.  text is send, with a chr(13) separating the
  1003.  lines.
  1004.  
  1005.  Not very usefull though...
  1006.  
  1007.